Getting ready for docs update #7
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the project’s getting started flow to use Arduino CLI commands for entering bootloader mode and installing CircuitPython, updates the README to point at the new docs site, and adds a dev container configuration.
- Update README to link to new docs site and remove manual button-press instructions
- Add Makefile targets for installing CircuitPython (
install-circuit-python) and listing TTY ports (list-tty) - Introduce a
.devcontainer/devcontainer.jsonfor a ready-to-use development container
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Revised project description and link to new docs site |
| Makefile | Added BOARD_TTY_PORT, new CLI targets, and tool setup |
| .devcontainer/devcontainer.json | Configured dev container environment and post-create step |
Comments suppressed due to low confidence (1)
README.md:6
- Since the detailed Getting Started steps were removed, consider adding brief instructions or examples for the new Makefile targets (e.g.,
make list-ttyandmake install-circuit-python) to help developers start right from the README.
This is the template repository for v5a PROVES Kit Flight Controller boards. Head to our [docs site](https://proveskit.github.io/pysquared/) to get started.
| .PHONY: list-tty | ||
| list-tty: arduino-cli ## List available TTY ports | ||
| @echo "TTY ports:" | ||
| @$(ARDUINO_CLI) board list | grep "USB" | awk '{print $$1}' |
There was a problem hiding this comment.
[nitpick] Filtering TTY ports by the string "USB" may miss valid ports in different environments. Consider using arduino-cli board list --format json or a more flexible filter to reliably enumerate serial devices.
There was a problem hiding this comment.
Good suggestion, I tried this. Unfortunately --format json does not work for this command. 😢
Summary
I'm rewriting the getting started docs and wanted to try avoid telling people to push specific buttons on the board. This change uses Arduino CLI to force the board into boot loader mode and install firmware. It also provides a consistent (🤞) way to find the TTY ports for our boards. This PR also links the readme to our new docs site and adds a dev container description.
How was this tested